home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / mebbs / ztick10.lha / ZTick.doc < prev   
Text File  |  1994-12-08  |  15KB  |  264 lines
  1.  
  2.                   ZTick - TICK utility for MEBBSNet
  3.  
  4. Release v1.0
  5.  
  6. Disclaimer - This software has been tested with the MungWall and Enforcer
  7. debugging utilities active.  Every effort possible was made to make this
  8. code bug-free.  However, I, Robert Miranda, only can guarentee that this will
  9. take up space on your hard disk provided you don't delete it.  Beyond that, I
  10. take no responsibility for ZTick's actions.  If you don't feel you can live with
  11. this, you have the power to resist using it.  For the brave, keep reading...
  12.  
  13. ZTick is intended to be a versatile .TIC file echo processor.  Many default
  14. paths are configurable.  File Echo tagnames and routing to other systems are
  15. limited only by your RAM space (linked lists, what a concept:^>).  Optional
  16. copy paths are allowed for custom situations (i.e. nodediff's can be copied to a
  17. nodelist directory AND be posted to your MEBBSNet file catalog.)  ZTick's main
  18. feature is that it reduces the pile of files that end up in the outbound
  19. directory because MEBBSNet (rightly so) won't delete files that don't match
  20. mail-related wildcards.
  21.  
  22. The archive should contain:
  23.  
  24.    ZTick - The executable.
  25.    
  26.    ZTick.doc - This file.
  27.  
  28.    ZTick.CFG - ZTick Global options configuration file.  Put this file in the
  29.                ConfigFiles/ directory off of your MEBBSNet: path.
  30.  
  31.    ZAreaTick.CFG - Areas definition file.  Put this file in the ConfigFiles/
  32.                    directory off of your MEBBSNet: path.
  33.  
  34.  
  35. Both .CFG files have documentation in them.  Both use the semicolon ';' to
  36. identify a comment line.
  37.  
  38. Testers Note: Nothing significant changed since v0.16.  Only text output.
  39.  
  40. What it does:
  41.  
  42. ZTick looks in your inbound directory for .TIC files.  They, in turn, have
  43. information about an actual file (1 per .TIC) that was sent to your system.
  44. Depending on your ZAreaTick.CFG configuration, that file may be added to
  45. a MEBBSNet file catalog, and/or copied to a path you specify.  In the event
  46. that you pass these files on to other systems, ZTick follows the following
  47. logic to specify the file in the outbound .FLO file:
  48.  
  49.    It will use the path to the file in database, if available, first.  If this
  50.       is the case, you will not have any files cluttering the outbound dir!
  51.    Next, it will use the PATH: you specify in ZAreaTick.CFG, if available.
  52.    (If this path is available the file gets copied there in any case).
  53.    If neither option above is available, it will put a copy of the file in the
  54.       OutBound directory and then insert the path into the .FLO file.
  55.  
  56. The ZTick.CFG should be modified to enable passwords, CRC check, and other
  57. options in the software you may need.  Once these are set, modify the
  58. ZAreaTick.CFG file, taking care to spell the MEBBSNet file areas and file
  59. echo areas properly.
  60.  
  61. Features
  62.  
  63.    Inbound .TICs: Adds the file to the MEBBSNet file catalog and/or copies
  64.    the file to a path you specify.  Undefined areas copied to the BAD
  65.    directory you specify.  Password checking (Optional/Per node), CRC (Global
  66.    option with individual override) are also included.
  67.  
  68.    Outbound .TICs: Uses the File Catalog path FIRST, the PATH: definition
  69.    file path SECOND, and will default to the Outbound directory LAST when
  70.    updating the outbound .FLO file.  .TIC files are always posted in the
  71.    outbound directory.
  72.  
  73.    Supports the .TIC 'REPLACES' keyword, which means that if the filename
  74.    following the keyword is in the catalog, it will be removed and then new
  75.    file added to the catalog.
  76.  
  77.    Replaces (a.k.a. updates) files that already exist in the catalog by removing
  78.    the old file and then adding the new file.
  79.  
  80.    Fully supports Zone:Net/Node notation for passing files on to other nodes.
  81.    Point systems are also supported in the software.  (Be aware that the 
  82.    Seen-By/Path duplication detection mechanisms don't support points, so
  83.    a point system shouldn't pass files along to other systems.)
  84.  
  85.  
  86. The nitty-gritty:
  87.  
  88.    Thanks to:
  89.       William Bowling - Author of MEBBSNet. - Whatever it was you said that night,
  90.         Bill, you got me motivated, that's for sure.
  91.       Russel Miranda - Original AmigaTick code.
  92.       Roger Walker formerly of Amigaville II - Former MEBBS Development 
  93.         Coordinator - Suggestions for options, testing, moral support.
  94.       Dave Cooper - Debugging, programming help, testing.
  95.       And there are probably others I missed...
  96.  
  97. Why did I do it?  Well, I didn't like what was available, I had the source from
  98. AmigaTick (From Russel Miranda), and I wanted to see if I could do it.
  99.  
  100. As of this time, the 1.0 release, I request that anyone that decides to use 
  101. this software as a regular part of their system to register with me by 
  102. sending me a note with your name, a method of contact, and basic information 
  103. on the system you run.  This is so I have an idea who is using my software.
  104. No fee is charged for this software, however contributions are welcome.  I 
  105. would appreciate comments, suggestions, and bug reports, with as much detail
  106. as possible, and the offending .TIC files if they still exist.
  107.  
  108. Also as of this 1.0 release, it may be included in any PD Collection (Including
  109. Fred Fish) or as part of any Disk of the Month (or similar software compilation)
  110. where only a minimum amount of money (less than $5.00 US) is charged to cover
  111. disk duplication and media costs only.  No special limitations are imposed upon
  112. commercial use.  This utility may be distributed as a part of MEBBSNet Professional
  113. BBS as a third party utility.
  114.  
  115. Robert Miranda
  116.  
  117. Email:
  118.  
  119.    FidoNet   1:268/428.0
  120.              1:13/737.0
  121.    AmyNet   40:702/201.0
  122.  
  123. SNail Mail: (Changed as of 8/94)
  124.  
  125.    Robert Miranda
  126.    RR 1 Box 284
  127.    Bushkill, PA  18324
  128.  
  129. Telephone:
  130.  
  131.    BBS: 610-622-9905
  132.    VOX: 610-622-9904 (This may turn into another data line in the future)
  133.    VOX: 610-626-3098
  134.    VOX: 717-588-7636 (Only if other methods fail, please. Leave msg.)
  135.  
  136.  
  137. History: (For historical purposes only :^> It's now bug free!?!)
  138.  
  139.    0.1b - Initial Release
  140.    0.2b - Removed: Debug Code displayed internal access level value.
  141.           Updated: Requires v1.9 of the MEBBSNet Utility Library.
  142.           Fixed: File wasn't removed from the inbound directory if a password
  143.                  mis-match occured.
  144.           Fixed: Properly handles NOPASSWORD option (I think).
  145.           Fixed: File wasn't removed from the inbound directory if a CRC
  146.                  mis-match occured.
  147.    0.3b   Fixed: Grunged SeenBy address was reporting an error that made no
  148.                  sense.
  149.           Updated: Requires v1.11 of the MEBBSNet Utility Library.
  150.           Fixed: MEBBSNet Library version.revision code would have had a
  151.                  problem if the version was incremented and the revision
  152.                  dropped back to 0.  No problem anymore.
  153.           Note: Negative numbered addresses are not parsed properly.  For the
  154.                 moment I'm not going to worry about it.
  155.           Fixed: Modification of a read-only string fixed by duplicating
  156.                  the string and modifying the copy.  Thanks for that one Bill!
  157.           Added: REPLACES Keyword in .TIC now handled.  It will replace the
  158.                  indicated file if it exists in the catalog.
  159.           FIRST release to the MEBBSNet Tester pool.
  160.    0.4b   Removed: Some debug messages dealing with the 'Replaces' function.
  161.           Fixed: Ztick Version string now reported (wasn't found with the
  162.                  version command).
  163.           Added: Version and revision information on the MEBBSNet Utility
  164.                  library is printed out immediately after the library is
  165.                  opened, and before it is tested by my code.  This will
  166.                  disappear in a future version, but should be useful for
  167.                  spotting update mistakes and other problems.
  168.           Fixed: Not placing a digit after the AccLev keyword in the ZTick.CFG
  169.                  file may have allowed a -1 access level value to be loaded.  I
  170.                  now ignore reading the NULL terminator on the line which results
  171.                  in the -1.  It should not have caused any problems, as I run it
  172.                  through an absoulte value function later on, but just in case.
  173.    0.5b   Added: The directory scan routine now will search for the wildcard of
  174.                  ????????.TIC instead of TK??????.TIC.  A user needed to handle
  175.                  AF??????.TIC, so I figured there could be others.  If any
  176.                  problems arise from this, please report them at once.
  177.           Note: The version string does not contain the 'b' at the end of the
  178.                 version number.  The 'b' is my identifier for a beta release.
  179.    0.6b   Oops: Forgot to update the docs.  See 0.7b.
  180.    0.7b   Fixed: (I hope) a bug where an endless loop could occur while scanning
  181.                  ZAreaTick.CFG.  0.6b was unsuccessful in stomping this bug, and
  182.                  introduced a bug that missed lines while reading that file.
  183.                  (Marco Volk - that may explain why files weren't going to all
  184.                  of your downlinks.  Thanks for the report).
  185.           Oops?: I think I had it set for 68030 code compiles only.  This may
  186.                  be the reason for some problems at some sites?
  187.           Note: Released only to 1 person.
  188.    0.8b   Note: Pulled out debug code from 0.7b.
  189.           Note: It seems stable here.  4/28/94.  Haven't released an update
  190.                 to all in over a month.  Feedback requested.
  191.           Note: Compiled with Optimization off.
  192.    0.9b   Fixed: Points weren't being compared in the address comparison
  193.                  function.  This resulted files not being sent to the points
  194.                  with the same Z:Ne/No number as the host.  Thanks Marco Volk.
  195.           Added: NOCRC: optional keyword added to ZAreaTick.CFG.  Allows you
  196.                  to disable the CRC check for an individual file echo area.
  197.    0.10b  Change: Generic line read/parse function wasn't generic enough to
  198.                   handle both .CFG and .TIC files IMHO.  Decided to split them up.
  199.                   Less processing on the .TIC makes it a tad more efficient.
  200.           Fixed: I have to check the catalog when a Replaces keyword and filename
  201.                  are present.  I wasn't freeing up a temporary string.  Minor
  202.                  memory eater.
  203.           Note: A MEBBSCFG defined file path that doesn't exist can cause problems.
  204.                 The symptom is 'Add To Device Failed' messages.  This problem
  205.                 results in the file being listed in the catalog, but the file
  206.                 can not get copied to one of the system catalog directories.
  207.                 Also, I get enforcer hits and odd pointers from some catalog
  208.                 functions until I kill the bad catalog entry or reboot.
  209.           Note: Date 6/27/94.
  210.           Fixed: Short descriptions that went over a certain length were not added.
  211.                  I finally debuged the behavior of the short description area and
  212.                  while I have yet to figure out what happens to CatRec.Description2,
  213.                  I know I'm not blowing out past the end of the string anymore.
  214.    0.11b  Note: General code cleanup.  .TIC keyword processing more efficient.
  215.           Change: Descriptions were using two 80-character lines as MEBBSNet
  216.                   provides.  This meant descriptions would overrun the right side
  217.                   of the screen.  I will chop it down to 40 characters until
  218.                   Mebbsnet handles it differently.
  219.    0.12b Fixed: The address that was added to the Path was my Zone:Net/Node.Point
  220.                 and not your system's numbers.  Now, Your #1 address is used for
  221.                 the Path, and all your active node numbers are used in the SeenBy.
  222.          Change: Upped the CRC and Copy routine buffers to 16K.  Was 4K.
  223.    0.13b Update: Raised the minimum mebbsutility.library version requirment
  224.                  to 1.18.
  225.          Removed: Option for non-Mebbs operation.  I may add it back later, but
  226.                   for now I rely on the mebbsutility.library heavily.
  227.          Change: Reduced the amount of potential characters read per line from
  228.                  both a .TIC file and the .CFG files from 511 to 159.  Two
  229.                  regular screen-widths should be enough.  Complain if this
  230.                  causes problems, but it shouldn't.
  231.          Change: Pulled out stack checking.  Smaller code (@1K).
  232.    0.14b Update: Raised the minimum mebbsutility.library version requirment
  233.                  to 1.19.  
  234.          Change: MEBBSNet now supports long filenames and as a result, the
  235.                  display can handle the full 2 lines (80 characters each)
  236.                  of file description text.  I now add up to 160 characters of
  237.                  description.
  238.          Fixed: Many RAM allocation failures weren't going to abort nicely.
  239.                 Code cleaned up.
  240.          Fixed: An oops created in 0.13 related to the length of the line read.
  241.                 It stomped a single byte in RAM somewhere - BAD!
  242.          Added: A check to see if the actual file described by the .TIC is
  243.                 present in the inbound directory.  Processing of that .TIC is
  244.                 aborted if the file is not found.
  245.          Fixed: When I created the NOPASSWORD option, I screwed up password
  246.                 checking (something that shouldn't go through might have made
  247.                 it).  The code was messy so I re-wrote the logic.
  248.          Fixed: I broke CRC-checking when I added the selective-disable option.
  249.                 It's fixed now (I forgot a simple '!').
  250.          Added: BUFFERSIZE: keyword now available in the ZTick.CFG file.
  251.                 Values of 4-1024 (this represents K-bytes) are permitted.
  252.                 The default is 16 (16K).  Check the example ZTick.CFG file for
  253.                 the format.
  254.          P-Note: Code size still under 30K! 8/24/94
  255.    0.15b Added: -N command line option to surpress the start/end of loggings
  256.                 when no .TIC files are found.  Reduces the log file size.
  257.          Update: Recompiled with the latest library header.  Requires v1.21
  258.                  of the mebbsutility.library.  Because of this, it now handles
  259.                  39 character filenames (AmigaDOS won't ever give me that much,
  260.                  but it's a safety net).
  261.    0.16b Changed: 80 character decriptions were wrapping due to the indentation
  262.                   of the description lines.  I trimmed the length to 74.
  263.    1.0 Release: Removed Beta/Tester strings.  No bugs reported since b4 0.14b!
  264.